Skip to content

/v1/domains/{domainId}/virtual-ledgers/{virtualLedgerId}/accounts

Request

Create a virtual account

Security
httpAuth
Path
domainIdstring, (uuid)required
virtualLedgerIdstring, (uuid)required
Body
idstring, (uuid)required
aliasstring, non-emptyrequired
descriptionstringrequired
customPropertiesobjectrequired
curl -i -X POST \
  'https://docs.ripple.com/_mock/products/custody/devbox/v1/domains/{domainId}/virtual-ledgers/{virtualLedgerId}/accounts' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "alias": "string",
    "description": "string",
    "customProperties": {
      "property1": "string",
      "property2": "string"
    }
  }'

Responses

Virtual Account created

Bodyapplication/json
idstring, (uuid)required
aliasstring, non-emptyrequired
depositIdentificationSourceArray of objectsrequired
metadataobjectrequired
Response
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "alias": "string",
  "depositIdentificationSource": [
    { … }
  ],
  "metadata": {
    "description": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "lastModifiedAt": "2019-08-24T14:15:22Z",
    "customProperties": { … }
  }
}